kanzi::GridLayout3D Class Reference
Grid Layout 3D arranges 3D items in a grid. More...
#include <kanzi/ui/node/grid_layout3d.hpp>
Inheritance diagram for kanzi::GridLayout3D:
Static Public Member Functions | |
| static GridLayout3DSharedPtr | create (Domain *domain, string_view name) |
| Creates a grid layout node. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
 Static Public Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| static unsigned int | getColumn (const Node &item) |
| Gets the column of an item. | |
| static unsigned int | getColumnSpan (const Node &item) |
| Gets the column span of an item. | |
| static unsigned int | getRow (const Node &item) |
| Gets the row of an item. | |
| static unsigned int | getRowSpan (const Node &item) |
| Gets the row span of an item. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static void | setColumn (Node &item, unsigned int column) |
| Sets the column of an item. | |
| static void | setColumnSpan (Node &item, unsigned int columnSpan) |
| Sets the column span of an item. | |
| static void | setRow (Node &item, unsigned int row) |
| Sets the row of an item. | |
| static void | setRowSpan (Node &item, unsigned int rowSpan) |
| Sets the row span of an item. | |
| Static Public Member Functions inherited from kanzi::Node3D | |
| static bool | isUnboundedLayoutSize (Vector3 layoutSize) |
| Returns whether a layout size is an unbounded layout size. | |
| static bool | isValidLayoutSize (Vector3 size) |
| Returns whether a given size is a valid layout size. | |
| static float | layoutUp () |
| Returns the direction toward which the y axis of a 3D node grows. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static Vector3 | replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize) |
| Replaces any elements in an unbounded layout size with the corresponding elements of a given size. | |
| static Vector3 | replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize) |
| Replaces any elements in an unbounded layout size with zero. | |
| static Vector3 | unboundedLayoutSize () |
| Returns an unbounded layout size. | |
| Static Public Member Functions inherited from kanzi::Node | |
| static bool | isUnboundedLayoutValue (float layoutValue) |
| Indicates whether a value is an unbound layout value. | |
| static bool | isValidLayoutValue (float value) |
| Indicates whether a value is valid layout value. | |
| static float | replaceUnboundedLayoutValue (float layoutValue, float resetValue) |
| Replaces layout value with the specified value if it is unbounded and returns it. | |
| static float | replaceUnboundedLayoutValueWithZero (float layoutValue) |
| Replaces layout value with zero if it is unbounded layout value and returns it. | |
| static float | unboundedLayoutValue () |
| Returns an unbounded layout value. | |
| Static Public Member Functions inherited from kanzi::Object | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
| Static Public Member Functions inherited from kanzi::MetaObject | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. | |
| Static Public Member Functions inherited from kanzi::GridLayoutConcept | |
| static float | accumulateMaximumSize (const RowColumnDefinitionContainer &definitions) |
| Calculates the sum of row or column definition's maximum sizes. | |
| static void | calculateOffsets (RowColumnDefinitionContainer &definitions) |
| Calculates grid row or column definition offsets according to current maximum sizes. | |
| static void | calculateWeightedSizes (RowColumnDefinitionContainer &definitions, float weightMultiplier) |
| Calculates grid row or column definition maximum sizes for weighted rows or columns. | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static void | parseRowColumnDefinitions (const string &definitionCollection, RowColumnDefinitionContainer &definitions) |
| Parse grid row or column definitions from property string. | |
Additional Inherited Members | |
| Public Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| void | addAutomaticColumn () |
| Adds a new automatic size column to the grid. | |
| void | addAutomaticRow () |
| Adds a new automatic size row to the grid. | |
| void | addFixedColumn (float size) |
| Adds a new fixed size column to the grid. | |
| void | addFixedRow (float size) |
| Adds a new fixed size row to the grid. | |
| void | addWeightedColumn (float weight) |
| Adds a new weighted size column to the grid. | |
| void | addWeightedRow (float weight) |
| Adds a new weighted size row to the grid. | |
| float | getActualColumnSize (unsigned int index) const |
| Gets the last calculated value for a grid column size. | |
| float | getActualRowSize (unsigned int index) const |
| Gets the last calculated value for a grid row size. | |
| unsigned int | getColumnCount () const |
| Gets the number of columns in the grid. | |
| string | getColumnDefinitions () const |
| Gets the ColumnDefinitions property. | |
| GridDirection | getDirection () const |
| Gets the Direction property. | |
| unsigned int | getRowCount () const |
| Gets the number of rows in the grid. | |
| string | getRowDefinitions () const |
| Gets the RowDefinitions property. | |
| void | removeColumn () |
| Removes the last column from the grid. | |
| void | removeRow () |
| Removes the last row from the grid. | |
| void | setColumnAutomatic (unsigned int index) |
| Sets a grid column to automatic size. | |
| void | setColumnDefinitions (string_view value) |
| Sets the ColumnDefinitions property. | |
| void | setColumnFixed (unsigned int index, float size) |
| Sets a grid column to a fixed size. | |
| void | setColumnWeighted (unsigned int index, float weight) |
| Sets a grid column to a weighted size. | |
| void | setDirection (GridDirection value) |
| Sets the Direction property. | |
| void | setRowAutomatic (unsigned int index) |
| Sets a grid row to automatic size. | |
| void | setRowDefinitions (string_view value) |
| Sets the RowDefinitions property. | |
| void | setRowFixed (unsigned int index, float size) |
| Sets a grid row to a fixed size. | |
| void | setRowWeighted (unsigned int index, float weight) |
| Sets a grid row to a weighted size. | |
| Public Member Functions inherited from kanzi::Node3D | |
| bool | addAbstractChildOverride (NodeSharedPtr child) override |
| void | addChild (const Node3DSharedPtr &child) |
| Adds a child node to a 3D node. | |
| void | arrange () |
| Performs layout arrangement on a 3D node. | |
| void | arrangeIterate () |
| Initial scene arrange. | |
| void | arrangeIterateLayout (bool propagateArrange) |
| void | arrangeIterateLayoutChild (bool propagateArrange) |
| ChildConstIterator | beginChildren () const |
| void | centeredArrange (Vector3 actualSize) const |
| Default implementation of arrange for a layout that accommodates all children at its center. | |
| Vector3 | centeredMeasure (Vector3 availableSize) const |
| Default implementation of measure for a layout that accommodates all children at its center. | |
| ChildConstIterator | endChildren () const |
| const RenderEntryParameterContainer * | generateRenderStates (DrawObjectsRenderPass &drawPass) |
| Gets a listing of render entry parameters to use to generate render states. | |
| size_t | getAbstractChildCountOverride () override |
| size_t | getAbstractChildIndexOverride (const Node &node) override |
| NodeSharedPtr | getAbstractChildOverride (size_t index) override |
| Vector3 | getActualSize () const |
| Returns the actual size of a 3D node. | |
| Vector3 | getAllocatedOffset () const |
| Returns the allocated offset of a 3D node. | |
| Vector3 | getAllocatedSize () const |
| Returns the allocated size of a 3D node. | |
| Matrix4x4 | getArrangeTransformation () const |
| Returns the layout transformation of a 3D node. | |
| virtual optional< Box > | getBoundingBox () const |
| Gets the bounding box of a 3D node. | |
| Node3DSharedPtr | getChild (size_t index) const |
Gets a child node at a given index. | |
| size_t | getChildCount () const |
| Gets the number of child nodes in a 3D node. | |
| size_t | getChildIndex (const Node &child) const |
Gets the index of a child node. | |
| Vector3 | getCoreDesiredSize () const |
| Returns the core desired size of a 3D node. | |
| Vector3 | getDesiredSize () const |
| Returns the desired size of a 3D node. | |
| Node3DSharedPtr | getFaceToCameraTarget () const |
| void | getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const |
| Returns the size of the bounding box of a 3D node. | |
| Node3DSharedPtr | getLookAtTarget () const |
| Vector3 | getMaximumBoundingBoxCoordinates () const |
| Returns the maximum coordinates for the bounding volume of a 3D node. | |
| Vector3 | getMinimumBoundingBoxCoordinates () const |
| Returns the minimum coordinates for the bounding volume of a 3D node. | |
| Node3DSharedPtr | getOrientationConstraintTarget () const |
| Vector3 | getPivotOffset () const |
| Returns the pivot offset of a 3D node. | |
| Node3DSharedPtr | getPositionConstraintTarget () const |
| RenderMode | getRenderMode () const |
| Returns the render mode. | |
| Vector3 | getSize () const |
| Returns the size of a 3D node. | |
| Vector3 | getStretchScale () const |
| Returns the stretch scale of a 3D node. | |
| bool | hasChild (const Node &child) const |
| Returns whether a child node exists. | |
| virtual pair< NodeSharedPtr, float > | hitTestContent (const Ray &ray) |
| Default hit test implementation of Node3D content. | |
| void | insertChild (size_t index, const Node3DSharedPtr &child) |
Adds to a 3D node a child node at a given index. | |
| bool | isPrimitiveLayout () const |
| Indicates whether a 3D node has primitive layout behavior. | |
| void | layout () |
| Calculates the layouts in a scene recursively. Calls the measure and arrange functions of every 3D node in the scene. | |
| void | measure (const Vector3 &availableSize) |
| Performs the default measure step. | |
| void | measureIterate () |
| Initial scene measure. | |
| virtual bool | measureRecursive () |
| Performs layout measurement for a 3D node. | |
| bool | moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override |
| Node::moveAbstractChildToPosition() implementation. | |
| void | moveChildToPosition (Node3DSharedPtr child, size_t index) |
| Moves a child node to a given position in the list of child nodes. | |
| void | moveToBack () |
| Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first. | |
| void | moveToFront () |
| Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last. | |
| void | onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override |
| Method executed on node property change. | |
| virtual void | onTransform () |
| Per-node step performed on transform, after Kanzi calculates the final transformation. | |
| ChildConstReverseIterator | rbeginChildren () const |
| void | registerDrawPass (DrawObjectsRenderPassSharedPtr drawPass) |
| Registers a DrawObjectsRenderPass that renders a 3D node. | |
| bool | removeAbstractChildOverride (Node &child) override |
| void | removeAllChildren () |
| Removes all child nodes from a 3D node. | |
| void | removeChild (const Node &child) |
Removes a child node from a 3D node. | |
| void | removeChild (size_t index) |
Removes from a 3D node a child node at a given index. | |
| ChildConstReverseIterator | rendChildren () const |
| void | render (Renderer3D &renderer, RenderEntry3D &renderEntry) |
| Renders a 3D node using a given render state. | |
| void | setActualSize (const Vector3 &actualSize) |
| Sets the actual size of a 3D node. | |
| void | setAllocatedOffset (const Vector3 &allocatedOffset) |
| Sets the allocated offset of a 3D node. | |
| void | setAllocatedSize (const Vector3 &layoutSize) |
| Sets the allocated size of a 3D node. | |
| void | setArrangeTransformation (const Matrix4x4 &value) |
| Sets the layout transformation of a 3D node. | |
| void | setAutoDepth () |
| Sets a node to determine its depth automatically. | |
| void | setAutoHeight () |
| Sets a node to determine its height automatically. | |
| void | setAutoSize () |
| Sets a node to determine its width, height, and depth automatically. | |
| void | setAutoWidth () |
| Sets a node to determine its width automatically. | |
| void | setCoreDesiredSize (const Vector3 &coreDesiredSize) |
| Sets the core desired size of a 3D node. | |
| void | setDesiredSize (const Vector3 &desiredSize) |
| Sets the desired size of a 3D node. | |
| void | setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax) |
| Sets the size of the bounding box of a 3D node. | |
| void | setPivotOffset (const Vector3 &pivotOffset) |
| Sets the pivot offset of a 3D node. | |
| void | setRenderMode (RenderMode mode) |
| Sets the render mode. | |
| void | setSize (float width, float height, float depth) |
| Sets the dimensions of a node. | |
| void | setSize (Vector3 size) |
| Sets the dimensions of a node. | |
| void | setStretchScale (const Vector3 &stretchScale) |
| Sets the stretch scale of a 3D node. | |
| ~Node3D () override | |
| Matrix4x4 | getFinalTransformation () const |
| Gets the value of the FinalTransformationProperty. | |
| void | setFinalTransformation (Matrix4x4 value) |
| Sets the value of the FinalTransformationProperty. | |
| float | getFrustumCullMargin () const |
| Gets the value of the FrustumCullMarginProperty. | |
| void | setFrustumCullMargin (float value) |
| Sets the value of the FrustumCullMarginProperty. | |
| SRTValue3D | getRenderTransformation () const |
| Gets the value of the RenderTransformationProperty. | |
| void | setRenderTransformation (SRTValue3D value) |
| Sets the value of the RenderTransformationProperty. | |
| SRTValue3D | getLayoutTransformation () const |
| Gets the value of the LayoutTransformationProperty. | |
| void | setLayoutTransformation (SRTValue3D value) |
| Sets the value of the LayoutTransformationProperty. | |
| Public Member Functions inherited from kanzi::Node | |
| ResourceSharedPtr | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | acquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. | |
| ResourceManager::AcquireTaskSharedPtr | acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const |
| Posts an asynchronous task to acquire a resource. | |
| ResourceDictionarySharedPtr | acquireResourceDictionary () |
| Gets a resource dictionary of a node. | |
| void | addAnonymousResource (ResourceSharedPtr resource) |
| Adds alias resource to an object node. | |
| void | addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator) |
| Transfers the ownership and attaches an input manipulator to an object node. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message handler where the handler is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message handler where the handler is a method that is invoked on an object. | |
| void | addNodeComponent (NodeComponentSharedPtr nodeComponent) |
| Transfers the ownership of a node component to an object node. | |
| void | addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner) |
| Transfers the ownership of a node component to an object node and sets the owner of the node component. | |
| void | addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference) |
| void | addResource (const ResourceID &resourceId, string_view resourceUrl) |
| Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. | |
| void | addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Adds a nested resource dictionary to the resource dictionary of a node. | |
| void | addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| template<typename TMessageType , typename TClass , typename TClassMethod > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method) |
| Adds a message filter where the filter is a method that is invoked on an object. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function) |
| Adds a message filter where the filter is a function. | |
| template<typename TMessageType > | |
| MessageSubscriptionToken | addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| AppliedStyleEntrySharedPtr | applyManualStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| AppliedStyleEntrySharedPtr | applyStyle (StyleSharedPtr style) |
| Applies a style to an object node. | |
| void | applyStyles () |
| Apply all styles for an object node. | |
| void | applyStylesRecursive () |
| Applies styles recursively. | |
| void | attachRecursive () |
| Attaches an object node and its children recursively. | |
| InputManipulatorConstIterator | beginInputManipulators () const |
| NodeComponentConstIterator | beginNodeComponents () const |
| void | clearChangeFlag (uint32_t flag) |
| Clears a change flag. | |
| void | clearChildChangeFlag (uint32_t flag) |
| Clears a child change flag. | |
| bool | containsResource (const ResourceID &resourceID) const |
| Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. | |
| BindingLookupContextPtr | createLookupContext (NodeSharedPtr templateRoot) |
| Creates a lookup context for the node. | |
| void | detachRecursive () |
| Detaches a node and its descendants. | |
| void | dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| template<typename TArgumentsType > | |
| void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
| Dispatches a message from this node with specified arguments. | |
| InputManipulatorConstIterator | endInputManipulators () const |
| NodeComponentConstIterator | endNodeComponents () const |
| template<typename TNodeType > | |
| shared_ptr< TNodeType > | findAbstractChild (string_view name) |
| Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. | |
| optional< string > | findResourceURL (const ResourceID &resourceId) const |
| Tries to find Resource URL for Resource ID from this node. | |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| uint32_t | getChangeFlags () const |
| Get current change flags. | |
| uint32_t | getChildChangeFlags () const |
| Get current child change flags. | |
| FocusManager * | getFocusManager () const |
| Returns the Focus Manager associated with the Screen node to which this node belongs. | |
| FocusScope * | getFocusScopeInfo () const |
| Returns the information about the focus scope for a node. | |
| InputManager * | getInputManager () const |
| Returns the Input Manager associated with the Screen node to which this node belongs. | |
| AbstractPropertyTypeDescriptor::ValueSource * | getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::DataType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| Node * | getParent () const |
| Returns the parent of the node. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. | |
| ResourceDictionarySharedPtr | getResourceDictionary () const |
| If a node has a resource dictionary, returns the resource dictionary of that node. | |
| Screen * | getScreen () const |
| Returns the Screen node to which this node belongs. | |
| NodeSharedPtr | getTemplateRoot () const |
| Gets the template root of this node. | |
| void | invalidateArrange () |
| Invalidates arrange. | |
| void | invalidateDraw () |
| Invalidates draw flag for the node. | |
| void | invalidateFinalTransform () |
| Invalidates final transform for node. | |
| void | invalidateMeasure () |
| Invalidates measure for the node. | |
| void | invalidateRender () |
| Invalidates render for node. | |
| bool | isAnyChangeFlagSet (uint32_t flag) const |
| Checks if any of given flags is set. | |
| bool | isAnyChildChangeFlagSet (uint32_t flag) const |
| Checks if any child change flags (corresponding to given mask) are set. | |
| bool | isAttached () const |
| Returns true if the node is attached to a screen or one of its descendants. | |
| bool | isAttaching () const |
| Returns true if node is in the process of attaching, false otherwise. | |
| bool | isChangeFlagSet (uint32_t flag) const |
| Checks if a change flag is set. | |
| bool | isChildChangeFlagSet (uint32_t flag) const |
| Checks if child change flags match. | |
| bool | isDetaching () const |
| Returns true if the node currently detaching. | |
| bool | isEffectivelyFocusable () const |
| Returns whether a node is focusable. | |
| bool | isEffectivelyVisible () const |
| Returns whether a node and its ancestor nodes are visible. | |
| bool | isInitialized () const |
| Returns true if initialize() has been called, false otherwise. | |
| bool | isInvalidArrange () const |
| Checks if the node needs arrange. | |
| bool | isInvalidDraw () |
| Tells if node draw flag is invalid. | |
| bool | isInvalidFinalTransform () const |
| Tells if final transform flag is invalid for node. | |
| bool | isInvalidMeasure () const |
| Check if the node needs measure. | |
| bool | isInvalidRender () const |
| Returns if node render flag is invalid. | |
| bool | isNamed (string_view name) const |
| KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty) | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNode (string_view pathOrKey) |
| Returns a node of specified type by looking it up with specified path or alias. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupNodeComponent (string_view name) |
| Returns a node component of specified type by looking it up with specified name. | |
| Node * | lookupNodeRaw (string_view relativePath) |
| Get an object node by another node and a relative path. | |
| ObjectSharedPtr | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| template<typename Type > | |
| shared_ptr< Type > | lookupObject (string_view relativePath) |
| Lookup for an object from a node. | |
| tuple< NodeSharedPtr, AbstractPropertyType > | lookupObjectForStateManager (string_view relativePath) |
| Lookup for an node and possible object from within the node for state manager. | |
| void | notifyResourceDictionaryModified () |
| Forces the re-evaluation of resource IDs in a node tree. | |
| void | removeAnonymousResource (const Resource &resource) |
| Removes anonymous resource from object node resources. | |
| void | removeInputManipulator (InputManipulator &inputManipulator) |
| Removes the ownership and detaches an input manipulator from an object node. | |
| void | removeKZBData () |
| Destroys all object node data loaded from KZB. | |
| void | removeKZBData (flat_set< AbstractPropertyType > *keepProperties) |
| Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. | |
| void | removeNodeComponent (NodeComponent &nodeComponent) |
| Removes the ownership of a node component from an object node. | |
| void | removeNodeComponentWithOwner (const void *owner) |
| Removes all bindings with the specified owner. | |
| void | removeNodeReference (const AbstractNodeReference &reference) |
| void | removeResource (const ResourceID &resourceId) |
| Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. | |
| void | removeResourceReference (const AbstractResourceReference &reference) |
| This is a helper for automatic resource tracking in ResourceReference. | |
| virtual void | restoreResources () |
| Reattaches an object node after potential resource change. | |
| void | setChangeFlag (uint32_t flag) |
| Sets a change flag. | |
| void | setChildChangeFlag (uint32_t flag) |
| Sets a child change flag. | |
| void | setParent (Node *parent) |
| Kanzi uses this method internally to set the parent of a node. | |
| void | setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary) |
| Replaces the resource dictionary of a node. | |
| void | setScreen (Screen *screen) |
| Sets the Screen node to which this node belongs. | |
| void | setTemplateRoot (NodeSharedPtr templateRoot) |
| Sets the template root of this node. | |
| ResourceSharedPtr | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| template<typename T > | |
| shared_ptr< T > | tryAcquireResource (const ResourceID &id) const |
| Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. | |
| KZ_DEPRECATED NodeSharedPtr | trySetActiveFocus () |
| Tries to move the focus on this node. | |
| NodeSharedPtr | trySetFocus () |
| Tries to move the focus to this node. | |
| NodeSharedPtr | trySetFocus (FocusFallback fallbackOption) |
| Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. | |
| void | unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| Unapplies a style from an object node. | |
| void | unapplyStyles () |
| Unapplies and removes all applied styles. | |
| void | unapplyStylesRecursive () |
| Unapplies styles recursively. | |
| void | validateArrange () |
| Validates arrange. | |
| void | validateDraw () |
| Validates draw flags for the node. | |
| void | validateDrawForChildrenRecursive () |
| Recursively validates draw for the children from this 2D node onwards. | |
| void | validateMeasure () |
| Validates measure for the node. | |
| void | validateRender () |
| Validates render for node. | |
| VisitorResult | visit (const Visitor &visitor, VisitorOrder order) |
| Visits a node and its descendants. | |
| VisitorResult | visitDescendants (const Visitor &visitor, VisitorOrder order) |
| Visits the descendants of a node. | |
| ~Node () override | |
| Destructor. | |
| string | getName () const |
| Gets the value of NameProperty. | |
| void | setName (string_view value) |
| Sets the value of NameProperty. | |
| string | getPath () const |
| Gets the value of PathProperty. | |
| void | setPath (string value) |
| Sets the value of PathProperty. | |
| string | getLocale () const |
| Gets the value of LocaleProperty. | |
| void | setLocale (string value) |
| Sets the value of LocaleProperty. | |
| bool | isHitTestable () const |
| Gets the value of HitTestableProperty. | |
| void | setHitTestable (bool value) |
| Sets the value of HitTestableProperty. | |
| bool | isHitTestableContainer () const |
| Gets the value of HitTestableContainerProperty. | |
| void | setHitTestableContainer (bool value) |
| Sets the value of HitTestableContainerProperty. | |
| bool | isVisible () const |
| Gets the value of VisibleProperty. | |
| void | setVisible (bool value) |
| Sets the value of VisibleProperty. | |
| bool | isEnabled () const |
| Returns the value of the EnabledProperty. | |
| void | setEnabled (bool value) |
| Sets the value of the EnabledProperty. | |
| bool | isEffectivelyEnabled () const |
| Returns the value of EffectivelyEnabledProperty. | |
| bool | isFocusable () const |
| Gets the value of the FocusableProperty. | |
| void | setFocusable (bool value) |
| Sets the value of the FocusableProperty. | |
| bool | isFocused () const |
| Gets the value of the FocusedProperty. | |
| void | setFocused (bool value) |
| Sets the value of the FocusedProperty. | |
| FocusState | getFocusState () const |
| Gets the value of the FocusStateProperty. | |
| void | setFocusState (FocusState state) |
| Sets the value of the FocusStateProperty. | |
| FontFamilySharedPtr | getFontFamily () const |
| Gets the font family the node uses. | |
| void | setFontFamily (FontFamilySharedPtr value) |
| Sets the font family the node uses. | |
| float | getVisibleAmountInParent () const |
| Gets the value of VisibleAmountInParentProperty. | |
| void | setVisibleAmountInParent (float value) |
| Sets the value of VisibleAmountInParentProperty. | |
| float | getProjection2DTo3DScale () const |
| Gets the value of Projection2DTo3DScaleProperty. | |
| void | setProjection2DTo3DScale (float value) |
| Sets the value of Projection2DTo3DScaleProperty. | |
| ResourceSharedPtr | getStyle () const |
| Gets the value of StyleProperty. | |
| void | setStyle (ResourceSharedPtr value) |
| Sets the value of StyleProperty. | |
| ResourceSharedPtr | getStateManager () const |
| Gets the value of StateManagerProperty. | |
| void | setStateManager (ResourceSharedPtr value) |
| Sets the value of StateManagerProperty. | |
| float | getWidth () const |
| Gets the value of WidthProperty. | |
| void | setWidth (float value) |
| Sets the value of WidthProperty. | |
| float | getHeight () const |
| Gets the value of HeightProperty. | |
| void | setHeight (float value) |
| Sets the value of HeightProperty. | |
| float | getDepth () const |
| Gets the value of DepthProperty. | |
| void | setDepth (float value) |
| Sets the value of DepthProperty. | |
| float | getActualWidth () const |
| Gets the value of ActualWidthProperty. | |
| void | setActualWidth (float value) |
| Sets the value of ActualWidthProperty. | |
| float | getActualHeight () const |
| Gets the value of ActualHeightProperty. | |
| void | setActualHeight (float value) |
| Sets the value of ActualHeightProperty. | |
| float | getActualDepth () const |
| Gets the value of ActualDepthProperty. | |
| void | setActualDepth (float value) |
| Sets the value of ActualDepthProperty. | |
| Node::HorizontalAlignment | getHorizontalAlignment () const |
| Gets the value of HorizontalAlignmentProperty. | |
| void | setHorizontalAlignment (Node::HorizontalAlignment value) |
| Sets the value of HorizontalAlignmentProperty. | |
| Node::VerticalAlignment | getVerticalAlignment () const |
| Gets the value of VerticalAlignmentProperty. | |
| void | setVerticalAlignment (Node::VerticalAlignment value) |
| Sets the value of VerticalAlignmentProperty. | |
| Node::DepthAlignment | getDepthAlignment () const |
| Gets the value of DepthAlignmentProperty. | |
| void | setDepthAlignment (Node::DepthAlignment value) |
| Sets the value of DepthAlignmentProperty. | |
| Vector2 | getHorizontalMargin () const |
| Gets the value of HorizontalMarginProperty. | |
| void | setHorizontalMargin (Vector2 value) |
| Sets the value of HorizontalMarginProperty. | |
| Vector2 | getVerticalMargin () const |
| Gets the value of VerticalMarginProperty. | |
| void | setVerticalMargin (Vector2 value) |
| Sets the value of VerticalMarginProperty. | |
| Vector2 | getDepthMargin () const |
| Gets the value of DepthMarginProperty. | |
| void | setDepthMargin (Vector2 value) |
| Sets the value of DepthMarginProperty. | |
| Node::ContentStretch | getContentStretch () const |
| Gets the value of ContentStretchProperty. | |
| void | setContentStretch (Node::ContentStretch value) |
| Sets the value of ContentStretchProperty. | |
| float | getOpacity () const |
| Gets the value of OpacityProperty. | |
| void | setOpacity (float value) |
| Sets the value of OpacityProperty. | |
| bool | isHover () const |
| Returns whether the node has HoverProperty set to true. | |
| bool | isClipChildren () const |
| Gets the value of ClipChildrenProperty. | |
| void | setClipChildren (bool value) |
| Sets the value of ClipChildrenProperty. | |
| Public Member Functions inherited from kanzi::Object | |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. | |
| void | applyObjectStyles () |
| Apply all styles for an object node. | |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. | |
| const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object. | |
| MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain. | |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object. | |
| Object (Domain *domain) | |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object. | |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. | |
| ~Object () override | |
| Public Member Functions inherited from kanzi::MetaObject | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. | |
| virtual | ~MetaObject () |
| Public Member Functions inherited from kanzi::PropertyObject | |
| template<typename DataType > | |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers. | |
| template<typename DataType > | |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container. | |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object. | |
| void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object. | |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container. | |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type. | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers. | |
| template<typename DataType > | |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type. | |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. | |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. | |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| PropertyObject () | |
| void | removeKzbProperties () |
| Remove all KZB properties. | |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set. | |
| template<typename DataType > | |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. | |
| template<typename DataType > | |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| template<typename DataType > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type. | |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. | |
| virtual | ~PropertyObject () |
| Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node > | |
| void | addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner) |
| Adds an already-created binding runtime to this binding host. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner) |
| Wrapper for setting a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Wrapper for setting a binding with owner. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot) |
| Sets a binding with no target. | |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| Sets a binding to a certain property. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field) |
| Wrapper for setting a modifier binding. | |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| Sets a modifier binding. | |
| Public Member Functions inherited from kanzi::BindingHostConcept | |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| Returns an iterator to the beginning of binding runtimes. | |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| Returns an iterator to the end of binding runtimes. | |
| AbstractBindingRuntimeSharedPtr | getBindingRuntime (size_t idx) |
| Gets binding by index. | |
| size_t | getBindingRuntimeCount () const |
| Gets the number of binding runtimes added to this node. | |
| void | removeAllBindings () |
| Removes all binding runtimes. | |
| void | removeBinding (BindingRuntimeHandle &bindingRuntime) |
| Removes a binding runtime added earlier. | |
| void | removeBindingsWithOwner (shared_ptr< void > owner) |
| Removes all binding runtimes with the specified owner. | |
| Static Public Attributes inherited from kanzi::Node3D | |
| static PropertyType< Matrix4x4 > | FinalTransformationProperty |
| Sets the final transformation of a 3D node. | |
| static PropertyType< float > | FrustumCullMarginProperty |
| Sets the margin of the frustum cull radius of a 3D node. | |
| static PropertyType< SRTValue3D > | RenderTransformationProperty |
| Sets the render transformation of a 3D node. | |
| static PropertyType< SRTValue3D > | LayoutTransformationProperty |
| Sets the transformation of a 3D node relative to its parent node. | |
| Static Public Attributes inherited from kanzi::Node | |
| static PropertyType< string > | NameProperty |
| Name property. | |
| static PropertyType< string > | PathProperty |
| Path property. | |
| static PropertyType< string > | LocaleProperty |
| Locale property. | |
| static PropertyType< bool > | CreatedFromKZBProperty |
| CreatedFromKZB property. | |
| static PropertyType< bool > | HitTestableProperty |
| HitTestable property. | |
| static PropertyType< bool > | HitTestableContainerProperty |
| HitTestableContainer property. | |
| static PropertyType< bool > | VisibleProperty |
| Visible property. | |
| static PropertyType< bool > | EnabledProperty |
| Sets whether the node is enabled. | |
| static PropertyType< bool > | EffectivelyEnabledProperty |
| Indicates whether the node and its ancestor nodes are enabled. | |
| static PropertyType< bool > | FocusableProperty |
| Sets whether a node can get focus and can participate in the focus chain navigation. | |
| static PropertyType< bool > | FocusedProperty |
| Sets whether a node is an focus node and can receive key messages. | |
| static PropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a focusable node or focus scope node. | |
| static PropertyType< ResourceSharedPtr > | FontFamilyProperty |
| Sets the font family the node uses. | |
| static PropertyType< float > | VisibleAmountInParentProperty |
| VisibleAmountInParent property. | |
| static PropertyType< float > | Projection2DTo3DScaleProperty |
| Projection2DTo3DScale property. | |
| static PropertyType< ResourceSharedPtr > | StyleProperty |
| Style property. | |
| static PropertyType< ResourceSharedPtr > | StateManagerProperty |
| StateManager property. | |
| static PropertyType< void * > | PrefabTemplateSourceProperty |
| PrefabTemplateSource property. | |
| static PropertyType< float > | WidthProperty |
| Width property. | |
| static PropertyType< float > | HeightProperty |
| Height property. | |
| static PropertyType< float > | DepthProperty |
| Depth property. | |
| static PropertyType< float > | ActualWidthProperty |
| ActualWidth property. | |
| static PropertyType< float > | ActualHeightProperty |
| ActualHeight property. | |
| static PropertyType< float > | ActualDepthProperty |
| ActualDepth property. | |
| static PropertyType< Node::HorizontalAlignment > | HorizontalAlignmentProperty |
| HorizontalAlignment property. | |
| static PropertyType< Node::VerticalAlignment > | VerticalAlignmentProperty |
| VerticalAlignment property. | |
| static PropertyType< Node::DepthAlignment > | DepthAlignmentProperty |
| DepthAlignment property. | |
| static PropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Vector2 > | DepthMarginProperty |
| Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. | |
| static PropertyType< Node::ContentStretch > | ContentStretchProperty |
| ContentStretch property. | |
| static PropertyType< float > | OpacityProperty |
| Opacity property. | |
| static PropertyType< bool > | HoverProperty |
| Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. | |
| static PropertyType< bool > | ClipChildrenProperty |
| ClipChildren property. | |
| static PropertyType< int > | SceneGraphAddNodeChangeChildFlagsProperty |
| SceneGraphAddNodeChangeChildFlags property. | |
| static PropertyType< int > | SceneGraphAddNodeChangeParentFlagsProperty |
| SceneGraphAddNodeChangeParentFlags property. | |
| static PropertyType< int > | SceneGraphRemoveNodeChangeChildFlagsProperty |
| SceneGraphRemoveNodeChangeChildFlags property. | |
| static PropertyType< int > | SceneGraphRemoveNodeChangeParentFlagsProperty |
| SceneGraphRemoveNodeChangeParentFlags property. | |
| Static Public Attributes inherited from kanzi::GridLayoutConcept | |
| static PropertyType< GridLayoutConcept::GridDirection > | DirectionProperty |
| Direction property. | |
| static PropertyType< string > | ColumnDefinitionsProperty |
| ColumnDefinitions property. | |
| static PropertyType< string > | RowDefinitionsProperty |
| RowDefinitions property. | |
| static PropertyType< int > | ColumnProperty |
| Column property. | |
| static PropertyType< int > | ColumnSpanProperty |
| ColumnSpan property. | |
| static PropertyType< int > | RowProperty |
| Row property. | |
| static PropertyType< int > | RowSpanProperty |
| RowSpan property. | |
| Protected Types inherited from kanzi::Object | |
| typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
| Applied style container. | |
| Static Protected Member Functions inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| static void | getNextItemLocation (const Node &node, GridObjectLocationWorkspace &workspace, unsigned int &out_row, unsigned int &out_column) |
| Decides the row and column for the next item in the grid. | |
| static void | getSpan (const Node &item, unsigned int &rowSpan, unsigned int &columnSpan) |
| Gets the span of a grid item. | |
| Static Protected Member Functions inherited from kanzi::Node | |
| static VisitorResult | applyStylesVisitor (Node &node, bool apply) |
| static VisitorResult | attachVisitor (Node &node) |
| static VisitorResult | detachVisitor (Node &node) |
| static bool | processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason) |
| Processes notification handlers for node and property storage. | |
| static VisitorResult | propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason) |
| static VisitorResult | updateAllResourcesVisitor (Node &node) |
| static VisitorResult | updateResourceVisitor (Node &node, const ResourceID &id) |
| static VisitorResult | validateDrawVisitor (Node &node) |
| Visitor for validating draw. | |
| Protected Attributes inherited from kanzi::GridLayoutConceptImpl< Node3D, GridLayout3D > | |
| float | m_accumulatedColumnSize |
| Total size of all columns. | |
| float | m_accumulatedRowSize |
| Total size of all rows. | |
| RowColumnDefinitionContainer | m_columns |
| Column definitions. | |
| float | m_columnWeights |
| Total weight of weighted columns. | |
| RowColumnDefinitionContainer | m_rows |
| Row definitions. | |
| float | m_rowWeights |
| Total weights of weighted rows. | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. | |
| Protected Attributes inherited from kanzi::BindingHostConcept | |
| BindingRuntimeContainer | m_bindingRuntimes |
| Bindings in this object. | |
Detailed Description
Grid Layout 3D arranges 3D items in a grid.
You can let the grid layout arrange the items automatically from the top-left towards the bottom-right corner, or manually assign each item to a specific row and column in a grid.
Note that the depth of the grid is the maximum depth for all the items in a grid.
When you want to manually assign items to a specific row and cell in a grid layout, use setRow() and setColumn().
When you let a grid layout to arrange items automatically, you can set the direction in which the grid layout arranges its items. For example, when you set the DirectionProperty property to GridDirectionDown, grid layout first places the items in the rows of the first column. When all the rows in the first column are full, grid layout starts placing the items in the rows of the second column, and so on. See setDirection().
When you create columns and rows in a grid layout you can specify how the grid layout calculates their size:
- You can let grid layout automatically calculate the size of the column and row based on the size of the largest item in that column and row. See addAutomaticRow(), addAutomaticColumn(), setRowAutomatic(), and setColumnAutomatic().
- You can set the exact size of a column and row. See addFixedRow(), addFixedColumn(), setRowFixed(), and setColumnFixed().
- You can set the size of the column and row in proportion to the remaining size of other columns and rows that use this same setting, and the size of the entire grid layout. See addWeightedRow(), addWeightedColumn(), setRowWeighted(), and setColumnWeighted().
For each cell in a grid layout you can set the number of columns and rows it spans. See setColumnSpan() and setRowSpan().
Examples
To create a Grid Layout 3D with two columns and two rows with automatic cell size, and set the grid to arrange the items in the grid columns from top to bottom:
// Create a GridLayout3D named Grid.
GridLayout3DSharedPtr grid = GridLayout3D::create(domain, "Grid");
// Set the grid so that it arranges the items in the grid by first adding them
// in the rows of the first column. When all the rows in the first column are full,
// grid starts adding the items in the rows of the second column, and so on.
grid->setDirection(GridLayoutConcept::GridDirectionDown);
// Set the grid to have two automatic columns and rows that get their size from
// the size of their content.
grid->addAutomaticColumn();
grid->addAutomaticColumn();
grid->addAutomaticRow();
grid->addAutomaticRow();
// Create and add four cubes, one to each cell in the grid. Let the grid
// automatically set which cells the child nodes occupy. Since #GridDirection is
// set to GridDirectionDown, the grid automatically arranges the items in the grid
// by first adding items to both rows in the first column from top to bottom,
// then both rows in the second column from top to bottom.
Model3DSharedPtr child1 = Model3D::createBox(domain, "Box1", Vector3(2.0f, 2.0f, 2.0f), ThemeRed);
grid->addChild(child1);
Model3DSharedPtr child2 = Model3D::createBox(domain, "Box2", Vector3(3.0f, 3.0f, 3.0f), ThemeBlue);
grid->addChild(child2);
Model3DSharedPtr child3 = Model3D::createBox(domain, "Box3", Vector3(1.0f, 1.0f, 1.0f), ThemeOrange);
grid->addChild(child3);
Model3DSharedPtr child4 = Model3D::createBox(domain, "Box4", Vector3(4.0f, 4.0f, 4.0f), ThemeGreen);
grid->addChild(child4);
To create a Grid Layout 3D with two columns and three rows whose sizes the grid calculates in proportion to the sizes of other columns and rows in the grid. For each item in the grid manually set which cells in the grid it occupies:
// Create a GridLayout3D named Grid.
GridLayout3DSharedPtr grid = GridLayout3D::create(domain, "Grid");
// Set the width and height of the entire grid to six units.
grid->setWidth(6.0f);
grid->setHeight(6.0f);
// Set the grid to have two weighted columns and three weighted rows.
// The first column gets one third and the second column two thirds
// of the entire grid width.
grid->addWeightedColumn(1.0f);
grid->addWeightedColumn(2.0f);
// Each row gets one third of the entire grid height.
grid->addWeightedRow(1.0f);
grid->addWeightedRow(1.0f);
grid->addWeightedRow(1.0f);
// Create an orange cube named Box1 and add it to the cell in the first row and the first column
// (the upper-left corner of the grid).
Model3DSharedPtr child1 = Model3D::createBox(domain, "Box1", Vector3(2.0f, 2.0f, 2.0f), ThemeOrange);
GridLayout3D::setColumn(*child1, 0);
GridLayout3D::setRow(*child1, 0);
grid->addChild(child1);
// Create a blue cube named Box2 and add it so that it spans the second and third cells in the first column.
Model3DSharedPtr child2 = Model3D::createBox(domain, "Box2", Vector3(3.0f, 3.0f, 3.0f), ThemeBlue);
GridLayout3D::setColumn(*child2, 0);
GridLayout3D::setRow(*child2, 1);
GridLayout3D::setRowSpan(*child2, 2);
grid->addChild(child2);
// Create a green cube named Box3 and add it to the cell in the third row and the second column.
// (the bottom-right corner of the grid).
Model3DSharedPtr child3 = Model3D::createBox(domain, "Box3", Vector3(1.0f, 1.0f, 1.0f), ThemeGreen);
GridLayout3D::setColumn(*child3, 1);
GridLayout3D::setRow(*child3, 2);
grid->addChild(child3);
To create a Grid Layout 3D with two columns and two rows, using both fixed and automatic cell size. By default the grid automatically sets which cells the items occupy:
// Create a GridLayout3D named Grid.
GridLayout3DSharedPtr grid = GridLayout3D::create(domain, "Grid");
// Set the grid to have two columns and two rows.
// Set the size of the first column to five units, but let the second column adapt
// its size from the size of its content.
grid->addFixedColumn(5.0f);
grid->addAutomaticColumn();
// Set the size of the first row to four units, but let the second row adapt its size
// from the size of its content.
grid->addFixedRow(4.0f);
grid->addAutomaticRow();
// Create and add three cubes to the grid and let the grid automatically set
// which cells the child nodes occupy. In this example, the three child nodes occupy
// the entire first row and the first column of the second row. The last cell (bottom-right)
// of the grid stays empty.
Model3DSharedPtr child1 = Model3D::createBox(domain, "Box1", Vector3(2.0f, 2.0f, 2.0f), ThemeOrange);
grid->addChild(child1);
Model3DSharedPtr child2 = Model3D::createBox(domain, "Box2", Vector3(3.0f, 3.0f, 3.0f), ThemeBlue);
grid->addChild(child2);
Model3DSharedPtr child3 = Model3D::createBox(domain, "Box3", Vector3(1.0f, 2.0f, 1.0f), ThemeGreen);
grid->addChild(child3);
Member Typedef Documentation
◆ ConceptClass
Constructor & Destructor Documentation
◆ GridLayout3D()
|
explicitprotected |
Constructor.
- Parameters
-
domain The UI domain the new node belongs to. name The name of the node.
Member Function Documentation
◆ create()
|
static |
Creates a grid layout node.
- Parameters
-
domain The UI domain the new node belongs to. name Name of the trajectory layout.
- Returns
- The created node.
◆ makeEditorInfo()
|
static |
◆ measureOverride()
Node3d::measureOverride() implementation.
Reimplemented from kanzi::Node3D.
◆ arrangeOverride()
Node3d::arrangeOverride() implementation.
Reimplemented from kanzi::Node3D.
The documentation for this class was generated from the following file:
- kanzi/ui/node/grid_layout3d.hpp